LCORE-1404: Updated config doc#1993
Merged
Merged
Conversation
Contributor
WalkthroughAdds unified-mode inference and Llama Stack configuration documentation across markdown, HTML, and JSON, introduces new unified provider/config schema sections, and updates the configuration PlantUML diagram. Also revises one ByokRag table entry’s wording and formatting. ChangesUnified configuration docs
ByokRag table text
Estimated review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/config.md`:
- Around line 808-809: The placeholder in the docs table for api_key_env is
being rendered as raw angle-bracket text, so update the Markdown in the config
docs to escape the placeholder inside the env reference and preserve the
intended literal ${env.<name>} format in generated HTML. Adjust the table entry
for api_key_env so the placeholder text is safely escaped while keeping the
surrounding description unchanged.
- Line 158: The `score_multiplier` description in the config docs contains an
escaped comparison typo that renders incorrectly. Update the text in the table
entry for `score_multiplier` so the comparison reads correctly as “less than 1”
instead of the malformed escaped sequence, keeping the rest of the
`docs/config.md` wording unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 44c77829-609f-4b99-a5a5-0ce5cfa16267
⛔ Files ignored due to path filters (2)
docs/config.pngis excluded by!**/*.pngdocs/config.svgis excluded by!**/*.svg
📒 Files selected for processing (4)
docs/config.htmldocs/config.jsondocs/config.mddocs/config.puml
📜 Review details
⏰ Context from checks skipped due to timeout. (13)
- GitHub Check: unit_tests (3.12)
- GitHub Check: build-pr
- GitHub Check: integration_tests (3.12)
- GitHub Check: integration_tests (3.13)
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-6-on-pull-request
- GitHub Check: E2E: server mode / ci / group 1
- GitHub Check: E2E Tests for Lightspeed Evaluation job
- GitHub Check: E2E: library mode / ci / group 3
- GitHub Check: E2E: server mode / ci / group 3
- GitHub Check: E2E: library mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 2
🔇 Additional comments (2)
docs/config.json (1)
891-898: LGTM!Also applies to: 1067-1079, 1706-1781
docs/config.puml (1)
302-312: LGTM!Also applies to: 358-382
| | embedding_dimension | integer | Dimensionality of embedding vectors. | | ||
| | vector_db_id | string | Vector database identification. | | ||
| | db_path | string | Path to RAG database. Required for inline::faiss. | | ||
| | score_multiplier | number | Multiplier applied to relevance scores from this vector store. Used to weight results when querying multiple knowledge sources. Values > 1 boost this store's results; values <; 1 reduce them. | |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix escaped comparison typo in score_multiplier description.
Line 158 has <; which renders incorrectly. It should be < 1.
Suggested fix
-| score_multiplier | number | ... Values > 1 boost this store's results; values <; 1 reduce them. |
+| score_multiplier | number | ... Values > 1 boost this store's results; values < 1 reduce them. |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| | score_multiplier | number | Multiplier applied to relevance scores from this vector store. Used to weight results when querying multiple knowledge sources. Values > 1 boost this store's results; values <; 1 reduce them. | | |
| | score_multiplier | number | Multiplier applied to relevance scores from this vector store. Used to weight results when querying multiple knowledge sources. Values > 1 boost this store's results; values < 1 reduce them. | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/config.md` at line 158, The `score_multiplier` description in the config
docs contains an escaped comparison typo that renders incorrectly. Update the
text in the table entry for `score_multiplier` so the comparison reads correctly
as “less than 1” instead of the malformed escaped sequence, keeping the rest of
the `docs/config.md` wording unchanged.
Comment on lines
+808
to
+809
| | api_key_env | string | Name of the environment variable holding the provider API key. Emitted as a ${env.<name>} reference so the secret is never written to disk in resolved form. | | ||
| | allowed_models | array | Optional allow-list of model identifiers for this provider. | |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Escape placeholder brackets to preserve ${env.<name>} in generated HTML.
At Line 808, <name> should be HTML-escaped in Markdown table text, otherwise downstream HTML rendering can lose the intended placeholder format.
Suggested fix
-| api_key_env | string | Name of the environment variable holding the provider API key. Emitted as a ${env.<name>} reference so the secret is never written to disk in resolved form. |
+| api_key_env | string | Name of the environment variable holding the provider API key. Emitted as a ${env.<name>} reference so the secret is never written to disk in resolved form. |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| | api_key_env | string | Name of the environment variable holding the provider API key. Emitted as a ${env.<name>} reference so the secret is never written to disk in resolved form. | | |
| | allowed_models | array | Optional allow-list of model identifiers for this provider. | | |
| | api_key_env | string | Name of the environment variable holding the provider API key. Emitted as a ${env.<name>} reference so the secret is never written to disk in resolved form. | | |
| | allowed_models | array | Optional allow-list of model identifiers for this provider. | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/config.md` around lines 808 - 809, The placeholder in the docs table for
api_key_env is being rendered as raw angle-bracket text, so update the Markdown
in the config docs to escape the placeholder inside the env reference and
preserve the intended literal ${env.<name>} format in generated HTML. Adjust the
table entry for api_key_env so the placeholder text is safely escaped while
keeping the surrounding description unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
LCORE-1404: Updated config doc
Type of change
Tools used to create PR
Related Tickets & Documents
Summary by CodeRabbit